<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../../print.css" type="text/css" media="print">
<meta content="BitmapDiff,com.allurent.flexunit2.vfu.model.BitmapDiff,averageDiffAllPixels,averageDiffNonMatchingPixels,bitmap1DiffPixels,bitmap2DiffPixels,highestAbsoluteColorDiff,largestDiffAreaDimension,matchingPixelCount,nonMatchingPixelCount,nonMatchingPixelData,overlapPixelCount,totalAbsoluteColorDiff,totalPixelCount,percentDifferent,percentIdentical" name="keywords">
<title>com.allurent.flexunit2.vfu.model.BitmapDiff</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'BitmapDiff - API Documentation';
				var baseRef = '../../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../index-list.html')" href="../../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../../index.html?com/allurent/flexunit2/vfu/model/BitmapDiff.html&amp;com/allurent/flexunit2/vfu/model/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;BitmapDiff</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class BitmapDiff"); titleBar_setSubNav(false,true,false,false,false,false,false,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.allurent.flexunit2.vfu.model</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class BitmapDiff</td>
</tr>
</table>
<p></p>
     BitmapDiff's mission is to carry data describing the differences between
     two BitmapData objects.
          <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../model/PixelDiff.html#absoluteColorDiff" target="">com.allurent.flexunit2.vfu.model.PixelDiff.absoluteColorDiff</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#averageDiffAllPixels">averageDiffAllPixels</a> : Number<div class="summaryTableDescription">
         The average absoluteColorDiff for all pixels.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#averageDiffNonMatchingPixels">averageDiffNonMatchingPixels</a> : Number<div class="summaryTableDescription">
         The average absoluteColorDiff for all non-matching pixels.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bitmap1DiffPixels">bitmap1DiffPixels</a> : BitmapData<div class="summaryTableDescription">
         Shows pixels in bitmap1 that aren't precisely matched
         in bitmap2.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bitmap2DiffPixels">bitmap2DiffPixels</a> : BitmapData<div class="summaryTableDescription">
         Shows pixels in bitmap2 that aren't precisely matched
         in bitmap1.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#highestAbsoluteColorDiff">highestAbsoluteColorDiff</a> : int<div class="summaryTableDescription">
         This var showest highest absoluteColorDiff amongst all non-identical pixels.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#largestDiffAreaDimension">largestDiffAreaDimension</a> : int<div class="summaryTableDescription">
         This figure is derived in the following manner:
            1.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#matchingPixelCount">matchingPixelCount</a> : int<div class="summaryTableDescription">
         The number of pixels that exist in both bitmaps and match precisely
         </div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#nonMatchingPixelCount">nonMatchingPixelCount</a> : int<div class="summaryTableDescription">
         The number of pixels that exist in either or both bitmaps but
         don't match (i.e.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#nonMatchingPixelData">nonMatchingPixelData</a> : Array<div class="summaryTableDescription">
         An Array of PixelDiff instances, one for each pixel that exists
         in either or both bitmaps but doesn't match.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#overlapPixelCount">overlapPixelCount</a> : int<div class="summaryTableDescription">
         The number of pixel locations that are included in both bitmaps
         </div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#percentDifferent">percentDifferent</a> : Number<div class="summaryTableDescription">[read-only]
         The percent of pixels in the two bitmaps that don't match.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#percentIdentical">percentIdentical</a> : Number<div class="summaryTableDescription">[read-only]
         The percent of pixels in the two bitmaps that are identical.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#totalAbsoluteColorDiff">totalAbsoluteColorDiff</a> : int<div class="summaryTableDescription">
         Total absoluteColorDiff for all non-matching pixels.</div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#totalPixelCount">totalPixelCount</a> : int<div class="summaryTableDescription">
         The number of pixels that exist in either or both of
         bitmap1 and bitmap2
         </div>
</td><td class="summaryTableOwnerCol">BitmapDiff</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="averageDiffAllPixels"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">averageDiffAllPixels</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>public var averageDiffAllPixels:Number</code><p>
         The average absoluteColorDiff for all pixels. Note that "all" includes
         pixels that exist in one bitmap but not in the other. See
         PixelDiff.absoluteColorDiff for a definition of absoluteColorDiff.
                  </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../model/PixelDiff.html#absoluteColorDiff" target="">com.allurent.flexunit2.vfu.model.PixelDiff.absoluteColorDiff</a>
</div>
</div>
<a name="averageDiffNonMatchingPixels"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">averageDiffNonMatchingPixels</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var averageDiffNonMatchingPixels:Number</code><p>
         The average absoluteColorDiff for all non-matching pixels. Note that
         this includes pixels that exist in one bitmap but not in the other. See
         PixelDiff.absoluteColorDiff for a definition of absoluteColorDiff.
                  </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../model/PixelDiff.html#absoluteColorDiff" target="">com.allurent.flexunit2.vfu.model.PixelDiff.absoluteColorDiff</a>
</div>
</div>
<a name="bitmap1DiffPixels"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">bitmap1DiffPixels</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var bitmap1DiffPixels:BitmapData</code><p>
         Shows pixels in bitmap1 that aren't precisely matched
         in bitmap2. All other pixels are set to transparent.
         </p></div>
<a name="bitmap2DiffPixels"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">bitmap2DiffPixels</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var bitmap2DiffPixels:BitmapData</code><p>
         Shows pixels in bitmap2 that aren't precisely matched
         in bitmap1. All other pixels are set to transparent.
         </p></div>
<a name="highestAbsoluteColorDiff"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">highestAbsoluteColorDiff</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var highestAbsoluteColorDiff:int</code><p>
         This var showest highest absoluteColorDiff amongst all non-identical pixels.
         See PixelDiff.absoluteColorDiff for a definition of absoluteColorDiff.
                  </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../model/PixelDiff.html#absoluteColorDiff" target="">com.allurent.flexunit2.vfu.model.PixelDiff.absoluteColorDiff</a>
</div>
</div>
<a name="largestDiffAreaDimension"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">largestDiffAreaDimension</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var largestDiffAreaDimension:int</code><p>
         This figure is derived in the following manner:
            1. Look at each continuous area of diff pixels (pixels that
               don't match precisely in both bitmaps). Contiguous is
               defined as pixels that are above, below, left or right
               of each other, and doesn't include pixels that only
               touch on the corner.
            2. Determine the bounding rect that encloses each area.
            3. Look at each vertical and horizontal dimension for these
               rects and select the longest one.
         </p></div>
<a name="matchingPixelCount"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">matchingPixelCount</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var matchingPixelCount:int</code><p>
         The number of pixels that exist in both bitmaps and match precisely
         </p></div>
<a name="nonMatchingPixelCount"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">nonMatchingPixelCount</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var nonMatchingPixelCount:int</code><p>
         The number of pixels that exist in either or both bitmaps but
         don't match (i.e. have different color or alpha values in the two
         bitmaps)
         </p></div>
<a name="nonMatchingPixelData"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">nonMatchingPixelData</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var nonMatchingPixelData:Array</code><p>
         An Array of PixelDiff instances, one for each pixel that exists
         in either or both bitmaps but doesn't match.
         </p></div>
<a name="overlapPixelCount"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">overlapPixelCount</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var overlapPixelCount:int</code><p>
         The number of pixel locations that are included in both bitmaps
         </p></div>
<a name="percentDifferent"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">percentDifferent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>percentDifferent:Number</code>&nbsp;&nbsp;[read-only]<p>
         The percent of pixels in the two bitmaps that don't match.
         Areas in either bitmap that don't overlap the other bitmap
         are considered be part of total area and to be non-identical.
         </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get percentDifferent():Number</code>
<br>
</div>
<a name="percentIdentical"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">percentIdentical</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>percentIdentical:Number</code>&nbsp;&nbsp;[read-only]<p>
         The percent of pixels in the two bitmaps that are identical.
         Areas in either bitmap that don't overlap the other bitmap
         are considered be part of total area and to be non-identical.
         </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get percentIdentical():Number</code>
<br>
</div>
<a name="totalAbsoluteColorDiff"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">totalAbsoluteColorDiff</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var totalAbsoluteColorDiff:int</code><p>
         Total absoluteColorDiff for all non-matching pixels. See
         PixelDiff.absoluteColorDiff for a definition of absoluteColorDiff.
                  </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../model/PixelDiff.html#absoluteColorDiff" target="">com.allurent.flexunit2.vfu.model.PixelDiff.absoluteColorDiff</a>
</div>
</div>
<a name="totalPixelCount"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">totalPixelCount</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var totalPixelCount:int</code><p>
         The number of pixels that exist in either or both of
         bitmap1 and bitmap2
         </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">Copyright (c) 2006-2007 Allurent Inc. All rights reserved. Generated 10/24/2007 03:44 PM. Build dev-version</center>
</div>
</body>
</html>
<!--Copyright (c) 2006-2007 Allurent Inc. All rights reserved. Generated 10/24/2007 03:44 PM. Build dev-version-->
